Get a placement catalog share view

POST

placement_catalog_shares

view

curl --request POST \
  --url https://your_a2_service/placement_catalog_shares/view \
  --header 'Content-Type: application/json' \
  --data '
{
  "placement_catalog_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "password": "<string>"
}
'

{
  "catalog": {
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "no": 123,
    "placement_ids": [
      "<string>"
    ],
    "settings": {
      "include_analytics": false,
      "indicators": []
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "placements": [
    {
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "no": 123,
      "campaign_permission": {
        "black": [],
        "white": []
      },
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "display": {
        "clktype": 1,
        "displayfmt": {
          "ext": {},
          "h": 250,
          "w": 300
        },
        "h": 250,
        "mime": [],
        "nativefmt": {
          "ext": {}
        },
        "w": 300
      },
      "ext": {
        "approval_method": "admin",
        "display": {
          "enabled": 0
        },
        "native": {
          "enabled": 0
        },
        "payout": "rates",
        "responsive": "fixed",
        "target_ecpm": 0,
        "video": {
          "enabled": 0
        }
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_active": false,
      "updated_at": "2023-11-07T05:31:56Z",
      "video": {
        "clktype": 1,
        "ctype": [
          2
        ],
        "delay": 0,
        "h": 300,
        "linear": 0,
        "maxdur": 0,
        "mime": [],
        "mindur": 0,
        "playmethod": [],
        "ptype": 1,
        "skip": 0,
        "skipafter": 0,
        "skipmin": 0,
        "w": 480
      }
    }
  ]
}

Body

application/json

지면 카탈로그 공유 보기 스키마.

placement_catalog_id

string<uuid>

required

지면 카탈로그의 ID

password

string | null

보호된 지면 카탈로그에 접근하기 위한 비밀번호

Response

Successful Response

지면 카탈로그 공유 보기를 위한 스키마.

catalog

PlacementCatalogSchema · object

required

지면 카탈로그 스키마

표시 하위 속성

catalog.created_by

string<uuid>

required

생성자 ID

catalog.description

string

required

The description in JSON Quill Delta format - a JSON format that represents rich text content
Links: https://quilljs.com/docs/delta

catalog.id

string<uuid>

required

catalog.name

string

required

지면 카탈로그 이름

catalog.no

integer

required

catalog.placement_ids

string[]

required

지면 ID 목록

catalog.settings

PlacementCatalogSettingSchema · object

required

지면 카탈로그 설정 스키마

표시 하위 속성

catalog.settings.include_analytics

boolean

default:false

지면 카탈로그에 각 광고 지면의 통계 데이터를 포함할지 여부를 결정합니다.

catalog.settings.indicators

enum<string>[]

지면 카탈로그에 포함될 지표 목록

Metric indicator enum.

사용 가능한 옵션:

budget_spent,

impression,

click,

conversion,

reach,

ad_revenue,

cpm,

cpc,

cpa,

roas

catalog.created_at

string<date-time> | null

생성 일시

catalog.updated_at

string<date-time> | null

변경 일시

placements

PlacementSchema · object[]

required

표시 하위 속성

placements.created_by

string<uuid>

required

지면 생성 사용자 ID

placements.name

string

required

이름

placements.no

integer

required

placements.campaign_permission

Permission · object

deprecated

권한

표시 하위 속성

placements.campaign_permission.black

string[]

placements.campaign_permission.white

string[]

placements.created_at

string<date-time> | null

생성 일시

placements.description

string | null

The description in JSON Quill Delta format - a JSON format that represents rich text content

Links: https://quilljs.com/docs/delta

placements.display

Display · object

디스플레이 배치 스키마. 배너 디스플레이 형식, 네이티브 형식 및 기타 디스플레이 관련 속성을 포함합니다.

표시 하위 속성

placements.display.clktype

enum<integer>

default:1

사용 가능한 옵션:

0,

1,

2,

3

placements.display.displayfmt

DisplayFormat · object

배너 디스플레이 형식의 속성(예: 크기)을 관리하는 객체 배열.

표시 하위 속성

placements.display.displayfmt.ext

Ext · object

placements.display.displayfmt.h

integer

default:250

placements.display.displayfmt.w

integer

default:300

placements.display.h

integer

default:250

placements.display.mime

string[]

placements.display.nativefmt

NativeFormat · object

네이티브 배치 스키마. 네이티브 배치 형식 및 기타 네이티브 관련 속성을 포함합니다.

표시 하위 속성

placements.display.nativefmt.ext

Ext · object

placements.display.w

integer

default:300

placements.ext

PlacementExt · object

지면의 기본 추가 설정을 위한 스키마.

표시 하위 속성

placements.ext.approval_method

enum<string>

default:admin

지면 게재 요청 시 승인 방법.

delegate: 지면 게재 권한이 있는 광고주는 지면 관리자의 승인 없이 게재가 가능합니다.
admin: 지면 관리자의 승인이 필요합니다.

사용 가능한 옵션:

admin,

delegate

placements.ext.display

Display · object

placements.ext.native

Native · object

placements.ext.payout

enum<string>

default:rates

기본 과금은 알고리즘에 의해 결정되는 최적화된 CPC, CPM 또는 CPA 금액입니다.

none: 지면에 대한 과금이 계산되지 않음 rates: 알고리즘에 의해 결정되는 최적화된 CPC, CPM 또는 CPA 금액

사용 가능한 옵션:

none,

rates

placements.ext.responsive

enum<string>

default:fixed

광고 소재가 지면 영역에 표시되는 방식을 정의

fixed: 광고 소재를 수정 없이 원본 크기로 표시 resized: 광고 소재 크기를 지면 영역 크기에 맞게 조정

사용 가능한 옵션:

fixed,

resized

placements.ext.target_ecpm

number

default:0

placements.ext.video

Video · object

placements.id

string<uuid> | null

placements.is_active

boolean

default:false

placements.updated_at

string<date-time> | null

변경 일시

placements.video

Video · object

Video

표시 하위 속성

placements.video.clktype

enum<integer>

default:1

사용 가능한 옵션:

0,

1,

2,

3

placements.video.ctype

integer[]

placements.video.delay

integer

default:0

placements.video.h

integer

default:300

placements.video.linear

enum<integer>

default:0

사용 가능한 옵션:

0,

1,

2

placements.video.maxdur

integer

default:0

placements.video.mime

string[]

placements.video.mindur

integer

default:0

placements.video.playmethod

enum<integer>[]

사용 가능한 옵션:

1,

2,

3,

4,

5,

6,

7

placements.video.ptype

enum<integer>

default:1

사용 가능한 옵션:

1,

2,

3,

4

placements.video.skip

enum<integer>

default:0

사용 가능한 옵션:

0,

1

placements.video.skipafter

integer

default:0

placements.video.skipmin

integer

default:0

placements.video.w

integer

default:480

Get a placement catalog share지면 카탈로그 공유 정보를 조회합니다.

⌘I

Get a placement catalog share view

curl --request POST \
  --url https://your_a2_service/placement_catalog_shares/view \
  --header 'Content-Type: application/json' \
  --data '
{
  "placement_catalog_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "password": "<string>"
}
'

{
  "catalog": {
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "no": 123,
    "placement_ids": [
      "<string>"
    ],
    "settings": {
      "include_analytics": false,
      "indicators": []
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "placements": [
    {
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "no": 123,
      "campaign_permission": {
        "black": [],
        "white": []
      },
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "display": {
        "clktype": 1,
        "displayfmt": {
          "ext": {},
          "h": 250,
          "w": 300
        },
        "h": 250,
        "mime": [],
        "nativefmt": {
          "ext": {}
        },
        "w": 300
      },
      "ext": {
        "approval_method": "admin",
        "display": {
          "enabled": 0
        },
        "native": {
          "enabled": 0
        },
        "payout": "rates",
        "responsive": "fixed",
        "target_ecpm": 0,
        "video": {
          "enabled": 0
        }
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_active": false,
      "updated_at": "2023-11-07T05:31:56Z",
      "video": {
        "clktype": 1,
        "ctype": [
          2
        ],
        "delay": 0,
        "h": 300,
        "linear": 0,
        "maxdur": 0,
        "mime": [],
        "mindur": 0,
        "playmethod": [],
        "ptype": 1,
        "skip": 0,
        "skipafter": 0,
        "skipmin": 0,
        "w": 480
      }
    }
  ]
}

Data Management APIs

Decision APIs

Get a placement catalog share view

Body

Response